Skip to content

updating our BUS documentation to improve clarity#361

Open
clairemcdyre wants to merge 5 commits intomainfrom
bus_docs_update
Open

updating our BUS documentation to improve clarity#361
clairemcdyre wants to merge 5 commits intomainfrom
bus_docs_update

Conversation

@clairemcdyre
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings March 6, 2026 14:33
@vercel
Copy link

vercel bot commented Mar 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cloudsmith-docs Ready Ready Preview, Comment Mar 6, 2026 2:59pm

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR rewrites the Block Until Scan documentation page to improve clarity. The page is restructured to clearly separate the default asynchronous enforcement behaviour from the optional synchronous enforcement mode, and to present setup requirements and expected outcomes in a more user-friendly way. The old step-by-step tutorial and Early Access warning with "important" variant have been replaced with concise reference content.

Changes:

  • The page heading is changed from "Block Until Scan" to "Enforce package signing and policy enforcement on all downloads," and the feature is now referred to as "synchronous enforcement mode."
  • The document is reorganised into four logical sections: default async behaviour, synchronous mode explanation, how to enable it, and what to expect.
  • Step-by-step validation instructions and code examples have been removed in favour of concise prose.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

clairemcdyre and others added 3 commits March 6, 2026 14:38
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
adding reference to the BUS name
Adding extra detail about cold + warm fetches.
adding co-pilot suggestion to remove redundant sentence.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants